read from socket
Type
command
Summary
Accepts data from a socket and places the data in the it variable.
Syntax
read from socket <socketID> [{until <dataString> | for <readAmount> [<chunkType>]}] [with message <callbackMessage>]
Description
Use the read from socket command to get data from another system via a TCP socket.
The until string form reads data until the specified string is encountered. The for amount form reads data until the specified number of chunks have arrived.
If you specify a callbackMessage, the message is sent to the object whose script contains the read from socket command, as soon as the read is finished. This message has two parameters: the socketID and the data received from the socket.
Parameters
| Name | Type | Description |
|---|---|---|
socketID | IP_addr | The identifier (set when you opened the socket) of the socket you want to get data from. The socket identifier starts with the IP address of the host the socket is connected to, and may optionally include a port number (separated from the IP address by a colon). If there is more than one socket connected to that host and port, you can specify which socket by appending the connection name or number that was assigned when the socket was opened, separated from the port number by a vertical bar (|). |
dataString | string | When LiveCode encounters the string in the socket data, it stops reading. If the string is not encountered, the read from socket command continues reading as long as there is data to be read. |
readAmount | int | A positive integer and specifies how much data to read. |
chunkType | enum | One of chars, characters, words, items, lines, int1, uInt1, int2, uint2, int4, or uint4. The read from socket command reads amount of the specified chunkType. If you don't specify a chunkType, readAmount of characters are read. |
callbackMessage | string | The name of a message to be sent when the read is successfully completed. |
Examples
read from socket "www.example.net:80" for 50 -- reads next 50 chars
read from socket "127.0.0.0:20|foo" until linefeed
read from socket mySocket for 30 uInt2s with message "gotData"
Related
function: result
glossary: object, property, binary file, variable, handler, message, socket, parameter, TCP, command
message: socketTimeout
property: socketTimeoutInterval, script
command: accept, post, open socket
Compatibility and Support
Introduced
LiveCode 1.0
OS
mac
windows
linux
ios
android
Platforms
desktop
server
mobile